Software Vault: The Diamond Collection

home *** CD-ROM | disk | FTP | other *** search

/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / mate120s.zip / TAGMATE.DOC < prev next >

Wrap

Text File | 1995-03-07 | 48KB | 1,178 lines

TAGMate v1.20 Standard (c) 1994-1995 TNT Software All Rights Reserved ─═[ Complete Documentation ]═─ Table of Contents I. Boring, but important, stuff you should know first. 1. Legal Notice 2. Slamming the "Shareware" Concept 3. Warranty 4. What This Program Does 5. System Requirements II. Upgrading from an older version of TAGMate. III. Upgrading from NewLog / DoorStat / AutoMail / Top 15. IV. First-Time Installation Instructions. 1. The Configuration File 2. "LOG" (NewLog) Mode a) Batch file setup b) Menu command setup c) Configurable colors d) Descriptions of the configurable options 3. "TRAK" (DoorStat) Mode a) Batch file setup b) Menu command setup c) Configurable colors d) Descriptions of the configurable options 4. "SEND" (AutoMail) Mode a) Input file setup b) Batch file setup c) Descriptions of the configurable options 5. "FILES" (Top 15) Mode a) Batch file setup b) Menu command setup c) Configurable colors d) Descriptions of the configurable options 6. Multiple Configuration Files / Setups a) "LOG" (NewLog) Mode b) "SEND" (AutoMail) Mode c) "FILES" (Top 15) Mode V. Support for TNT Software Products. VI. Acknowledgements. I. Boring, but important, stuff you should know first. ══════════════════════════════════════════════════════ 1. Legal Notice ─────────────── This program is copyrighted software but you are free to distribute it as long as all files remain in their original, unmodified state, and that the PKZIP -AV (authenticity verification) remains in-tact as well. You can this program as much as you want, as often as you want, provided that you do not attempt to hack the software and re-distribute it. You're permit- ted to modify it with a HEX editor, debugger, etc as long as you don't re-dis- tribute it after you have modified it (much like the T.A.G. BBS policy). 2. Slamming the "Shareware" Concept ─────────────────────────────────── This program is not, hasn't been, and never, EVER will be shareware. This program (as well as all of my other T.A.G. BBS utilities) are absolutely FREE to everyone. No one in the world should have to pay ANYTHING to run my programs, especially since they come with no guarantees, and I could simply run off with your money, or quit writing the software. If you ask me, a great deal of shareware is nothing but worthless crap, why should you have to pay hard-earned cash for a small TAG BBS utility (written for a freeware BBS program, I might add) to an author that gets 100% profit from the money you send in? Seems like baloney to me. Think about this -- add up the total price of all the "registration fees" of the demo versions of shareware programs that you've had. You would undoubtedly be rich if you had that sum. The simple joy and challenge of programming should be more than enough incentives for BBS utility authors to write their programs. You can count on TNT Software for creating free, non-crippled, highly-reliable, often-updated software for T.A.G. BBS -- I didn't pay anything to make it, you shouldn't have to pay anything to use it. 3. Warranty ─────────── This program comes with NO warranty of any kind. Any loss of data, damage to your system, or unexpected/unexplained/unwanted results are NOT the author's fault and are NOT the author's responsibility. This program is only guarant- eed to take up hard disk space! However, if you DO have a problem, I would be more than happy to help you figure out a solution to what ever your problem might be and offer my services. 4. What This Program Does ───────────────────────── TAGMate is a collection of updated versions of my old utilities, basically. The entire package is also FREE to everybody that wants it, as well as support for it (other than the telephone bill). It's basic functions are: "LOG" -- Formerly my NewLog program. You run the LOG function from your LOGON.BAT and it takes the current user information such as the user name, city, BPS rate, node number calling, and it places it in a more-informative, colorful alternate caller's log that your users can view via a menu command. It also combines all nodes' caller's logs into ONE file and says what node each user logged on to (and when, exactly). "TRAK" -- Formerly my DoorStat program. You run the TRAK function from all of your door batch files and it keeps track of the number of times each door was entered (along with percentages) in a very colorful, informative file that your users can view. "SEND" -- Formerly my AutoMail program. You can use this to send private E-Mail messages to users automatically. It also supports public messages as well. For more details on why this program is useful, see the "SEND" chapter of this document. It now supports Fido, Hudson, and (as of v1.00) JAM formats! "FILES" -- Formerly my Top 15 files program. You run this program nightly in a maintenance batch file and it will come up with a listing of the top 15 most-downloaded (or most-popular) files on the system. Colorful output format viewable by users, supports restriction of file areas by AR flags and min/max DSLs. 5. System Requirements ────────────────────── There are four basic requirements for running TAGMate; they are: 1. An IBM-compatible computer with at least an 8086 processor. (The faster the processor, the faster your outputs are made). 2. A hard disk with at least 200K or so free on it. (The faster the hard disk, the faster your outputs are made). 3. An MS-DOS-compatible operating system, such as MS-DOS v6.22. (Anything that will run MS-DOS programs will suffice). 4. A fairly-recent copy of T.A.G. BBS. (Any version that uses the FILES.DIR structure that v2.7 uses). II. Upgrading from an older version of TAGMate. ═══════════════════════════════════════════════ For version 1.xx to version 1.20: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ (1) Unzip/copy all of the new executable and overlay files over the old old ones in your TAGMate directory (TAGMATE.EXE/OVR, DOOREDIT.EXE, etc). (2) Convert your "TRAK"-mode door file to version 1.20 format by running "116TO120.EXE" which should have been included with the v1.20 archive. (3) Check out the new "LogPhone" option which is documented later in this doc file and in the default configuration file, and see if you would like to use it in any of your configurations. III. Upgrading from NewLog / DoorStat / AutoMail / Top 15. ══════════════════════════════════════════════════════════ Before you begin, I would strongly recommend having a split-screen text file editor (e.g. QEdit). This will make it a lot easier to edit the configuration and batch files. A printer would work good, too. You could print off your old, text configuration files to read as you edit the TAGMATE.CFG file. It's suggested that "TAGMATE.OVR" and "TAGMATE.EXE" both reside in your node 1 main BBS directory! The same goes for any configuration files that TAGMate will need. Be sure to check out the spiffy help screens and error handling. Try typing "TAGMATE" (with no parameters) and "TAGMATE <function> ?" to get more help. NewLog ────── -=> If you run multi-node or multiple configurations, read the section the -=> Q&A section after you've incorporated one of your nodes NLOGx.CFGs into -=> your TAGMATE.CFG with these instructions. - Configuration File All you really need to do, is block-copy or re-enter your options from your NEWLOG.CFG into TAGMATE.CFG. You need to remove the "NL_" that precedes each option. The options are all the same, except for the following: o "NL_Baud" is now "BPSRate". o "NL_VersionBox" is now "VersionInfo". o "NL_PauseAtEnd" is now "AppendPause". o "TitleColor" will be the color of your "TitleString". o All ^C# colors in "TitleString" are stripped, and "TitleColor" is added in front of it, and it's automatically centered. Other than that, everything else is named the same (minus the "NL_") and is functionally the same. - Command Line / Batch File Execution The command line has changed from: NEWLOG <configuration file> /C <user number> <BPS rate> NEWLOG <configuration file> /L <comment> To: TAGMATE <configuration file> LOG /C <user number> <BPS rate> TAGMATE <configuration file> LOG /L <comment> You must do this in _all_ batch files that you plan on running the "log" feature from. DoorStat ──────── - Configuration File All the options are the exact same (minus the "DS_") both in the configuration file, and functionally. - Data File Location / Editing You can use the EXACT same door data file when you install TAGMate over DoorStat. I did not change the structure of it one bit. However, the editor is now external as "DOOREDIT.EXE". It should have been included with this archive. In case you ever feel the need to edit the door database or manually re-set it, you can use DoorEdit. I spiffed it up a bit for you - (you can use cursor keys in Yes/No prompts, etc). To run DOOREDIT, just feed it the path/filename of the door data file you wish to edit as the first command-line parameter. - Command Line / Batch File Execution Okay, now here's the fun part. Rather than change _ALL_ those command- lines that you have in _ALL_ of your door batch files to say "TAGMATE" instead of "DOORSTAT", you can simply do this: (1) Erase your DOORSTAT.EXE. (2) Create a "DOORSTAT.BAT" in the same directory that you just erased "DOORSTAT.EXE" from. (3) Have "DOORSTAT.BAT" as this: @ECHO OFF CD\BBS TAGMATE TAGMATE.CFG TRAK %2 %3 %4 %5 %6 %7 %8 %9 (Substitute "\BBS" for which ever directory you have your TAGMATE.EXE and TAGMATE.CFG). AutoMail ──────── -=> If you ran a mutli-configuration setup with AutoMail (sent mail to people -=> for several different purposes, using separate .CFG files) please see the -=> end of this file after you've incorporated one .CFG into your TAGMATE.CFG. - Configuration File The configuration file, again, is the _exact_ same both functionally and cosmetically (minus the "AM_"'s). - Command Line / Batch File Execution The command line has changed from: AUTOMAIL <configuration file> [#]<from> [#]<to> To: TAGMATE <configuration file> SEND [#]<from> [#]<to> Therefore, edit any batch file that calls "AutoMail" to reflect the changes. Note that you can use _one_ "Send" configuration in your TAGMATE.CFG file itself. Top 15 ────── I recommend completely re-installing the program. Erase any old .EXE files, .CFG files, and output files that your old (and I _do_ mean OLD) Top 15 program created/used. The "Files" function is far superior to the old Top 15, especially as far as how it is programmed. All options available are documented in the default TAGMATE.CFG file, with examples. Multiple Configurations with NewLog and AutoMail ──────────────────────────────────────────────── Q: I ran a multi-node caller's log with NewLog with several "NLOGx.CFG" files, is there any way I can get TAGMate to support the multi-configuration setup that my old NewLog did? A: Yep! Use your first node in "TAGMATE.CFG" along with the other programs. Then, create a new file, "NODE2.CFG" or something to the tune of that, and all you need to include is the "[Global]" and "[Log]" sections of the file -- you can eliminate all other program configuration options and comments. Then, edit the MainBBSDir in "NODE2.CFG" to be node 2's Main BBS directory (instead of node 1's, as in TAGMATE.CFG). And, finally, for your LOGON.BAT for node 2, call TAGMATE with "TAGMATE NODE2.CFG LOG /C %3 %8" instead of "TAGMATE TAGMATE.CFG LOG /C %3 %8" as in node 1's LOGON.BAT. Q: I used AutoMail for more than one purpose. Is there any way I can get it to support the multiple configuration setup I had with the original AutoMail? A: Yep! For example, say the purposes that you used AutoMail for were to E-Mail new users a welcome message, and to post rules in a conference that you are a moderator of. Well, you would use _one_ of those in the "[Send]" clause of "TAGMATE.CFG", and the rest you would make separate configuration files by copying out the "[Global]" and "[Send]" clauses (so, basically the same thing you do for multi-node NewLog setup). Then, you edit the NEWLOGON.BAT to execute "TAGMATE TAGMATE.CFG SEND #1 #%3" (assuming the 'new user E-Mail' message path and other configuration options are set in "TAGMATE.CFG"), and any other executions for other purposes must go in separate configuration files/command lines. Please NetMail me or get in touch with me if you have any questions about the multi-node/multi-configuration setup. It's pretty confusing, I know, but it's a pain to program an unlimited node/unlimited purpose supporting "single" con- figuration file. This way, the program can be completely flexible. IV. First-Time Installation Instructions. ═════════════════════════════════════════ First things first. Obviously you've UnZIPped the archive already -- just make sure that you put TAGMATE.EXE, TAGMATE.OVR, and DEFAULT.CFG in your node 1 Main BBS directory. 1. The Configuration File ───────────────────────── The first thing you need to do is copy or rename DEFAULT.CFG to TAGMATE.CFG. Now, edit TAGMATE.CFG with your favorite text editor (mine is QEdit v3.00). You will notice that it is a very large file, and very confusing-looking. Just follow along and hopefully you won't get lost. The first thing you do is edit the section "[Global]". The "sections" are divided up kind of like a Windows .INI file. This section supplies vital information to all functions that within TAGMate. It is important that these options are modified to be as accurate as possible. Edit the "MainBBSPath" to show the directory of your node 1 STATUS.DAT file. While you're at it, edit "UserLstPath" to show the directory of your USER.LST file. TAGMate will adjust trailing backslashes accordingly, you don't have to worry about whether or not to put a backslash ("\") at the end or not. Now that you've got those [Global] options squared away, you can begin editing the rest of the functions' options that are in the configuration file. It is up to you which functions you want to run, and you can erase any excess data from the configuration file with your text editor such as comments, unused function configuration options, etc. 2. "LOG" (NewLog) Mode ────────────────────── a) Batch file setup =================== In order for TAGMate/LOG to know how to behave, you must give it certain instructions via the MS-DOS command line (or in a batch file). If you already have a LOGON.BAT file, edit it and add the following line (if not, then create one with this command in it): TAGMATE <Configuration file> LOG /C %3 %8 "<Configuration file>" is the edited, text configuration file that you are using for this node. "/C" tells TAGMate that it is a call (see below for the definition of "/L"). "%3" and "%8" are parameters that are automatically passed by T.A.G. when it calls the LOGON.BAT at the appropriate time. "%3" is the user number, and "%8" is the real connection rate. Now, if you want to log other events such as system re-boots, inbound mail calls, etc, you set it up in the appropriate batch file with the following parameters: TAGMATE <Configuration file> LOG /L <Comments> "<Comments>" can be any text string. For instance, if you want the program to write "Daily Maintenance Executed" in your output file when you BBS daily maintenance runs, then add this as the first line in what ever batch file your maintenance is carried out in: TAGMATE <Configuration file> LOG /L Daily Maintenance Executed Suggested uses for this: * Log when your system processes echomail (in your MAILER.BAT). * Start and/or ending of daily maintenance. * When a user goes into a door or mail door. * When the computer is reset (in your AUTOEXEC.BAT). b) Menu command setup ===================== Get into your system's menu editor by pressing Control-Q or S from the T.A.G. Wait Screen, or by typing //MENUEDIT from the main menu if you are running the default T.A.G. menus. Choose the main menu by pressing M to modify, followed by 1 for main. Press M again to modify, then choose the (L)og callers command. Change the program data to "@CALL_LOG", assuming you used the default filename that was included in the configuration file ("...\AFILES\CALL_LOG.MSG"). If you changed it, put whatever you changed it to WITHOUT the ".MSG" extension. So, if you changed it to "C:\BBS\AFILES\NEWLOG.MSG", change the program data to "@NEWLOG". c) Configurable colors ====================== Depending on your system's color scheme, you and your users may or may not like the looks of the default colors included with TAGMate/LOG. If not, go ahead and edit them in the configuration file to suit your needs. Most are self-explanatory, and all are explained via commenting in the file. d) Descriptions of the configurable options =========================================== *** NOTE: All options go under the "[Log]" heading in TAGMATE.CFG! *** "Log" is the equivalent of NewLog v3.15, with some more enhancements and many bug fixes. Below is an explanation of some of the options which may be some- what confusing and require additional setup outside of the configuration file. MultiString / MultiLog ---------------------- As of TAGMate v0.90, "LOG" can now broadcast a message to all other nodes of the system in the same way the T.A.G. BBS Broadcast command works. The message can say what ever you wish (definable in the MultiString option), but if "MultiLog" is enabled, the "MultiString" will be sent to all nodes of the system as of each logon. For instance, if I log on node 1 of 3, a message will be sent to all other nodes in roughly this format: Message from Node 1: Joe McElmeel from Lincoln Park, MI (9600 bps) [User Logging on] Feel free to use T.A.G. ^C# colors in this feature as well! AltString / AltChar ------------------- TAGMate has a feature that can (optionally) take the user on-line's extra character, and if that is equal to "Y" (for Yes), it will put one of the extra strings out to the caller's log. The string can contain anything -- it's user-defined; for instance, sayings, comments, wise-cracks, or anything. An example of this would be: Inferno from Riverview, MI (14400), on node 1. "Hello, this is an example!" (The second line being the string that the user defined). If you wish to take advantage of this feature, you must have at least one extra character and at least one extra string field that you are not using for user data on your system (in the user-editor). Edit the [Log] configuration section and tell it which extra string and which extra character to use (see the default configuration file for more details on the actual commands). After you are sure you have that, go in with your favorite text editor and edit your "MSTRMSG.TXT" file in your AFILES directory. Modify the "*USER_EXTRA_CHAR_x" (x being which ever one is not being used) to reflect something along the lines of "Do you want something else to be logged in the caller's log? (Y/N): @@@". Also, edit the "*USER_EXTRA_CHAR_x_LISTING", and "*USER_EXTRA_CHAR_x_VERIFY" fields. Change the "*USER_EXTRA_CHAR_x_VALID" to allow only "YN". Now, edit the "*USER_EXTRA_STRING_x" fields to say something along the lines of "Enter what you want to show up in the callers log: @@@". Do not forget to re-compile your strings using TAGSTR.EXE. After you've done that, add the menu commands in the Personal Data menu on your BBS so your users can change the string and the Yes/No option if they want to (see the T.A.G. documentation for more details on how to edit menu commands). Finally, I would advise adding two new "new user questions" in your New User Configuration in //SYSTEMCONFIG. Have the Yes/No prompt be asked right before the prompt for the actual string. If you need additional help, please get in contact with me in one of the ways listed near the end of this document (sorry if I seemed a bit cryptic). LogMode and ExtraField ---------------------- Both of these options affect how the log will be formatted. For "LogMode", you can have "COLUMNS" or "NORMAL". Columns mode is formatted in columns, and normal mode is not formatted at all and is slightly more verbose. Experiment with them until you find which one you or your users like better. "ExtraField" allows "CALLS", "NODES", or "NONE". "CALLS" will log the number of calls the user has called the system today, "NODES" will log what node number the users have been calling on, and "NONE" logs neither of them. TitleString ----------- Title string that is centered just before the banner file and after the date in the caller's log. Can contain ^C# color codes, but the "TitleColor" option is placed before it, which over-rides it, and it's automatically centered now. BannerFile ---------- Complete path and filename of an ASCII file that supports ^C# codes and SDR codes to display in front of the caller's log. This file can contain anything, but typically it contains system statistics and other tidbits of information. OldLog ------ "OldLog" is an optional complete path (and filename) to write "yesterday's" caller's log file to. This is typically a bulletin that users can view if they want to see who called yesterday. It determines if the log is old by the MS-DOS file date/time stamp. If it's old, then it copies it to this path then starts a new log with whatever the current call or event is being logged at run time. LogPhone -------- "LogPhone" allows you to put either the user's VOICE telephone number, DATA telephone number, or EXTRA telephone number into the log. The point of this option is so you can make a separate caller's log that tells you everybody's phone number for comparison with caller-ID or for any other reason that you wish it to be for. It is NOT suggested that you have the log with the telephone numbers viewable by all of the other users. CoSysOps, yeah, but not other users of your system -- they will get very pissed off! An example of this would be to create two separate log files and having two separate commands set up to view them (the second of which only SysOps and Co- SysOps can access). The first would display the regular old callers' log like it always has been, and the second would be your "caller ID comparison" log. You would have to call TAGMate twice in your LOGON.BAT file in order to pull this off. An example would be: @ECHO OFF TAGMATE TAGMATE.CFG LOG /C %3 %8 TAGMATE SYSOP.CFG LOG /C %3 %8 ...but, in SYSOP.CFG, you have a different output file defined and you have the "LogPhone" option enabled. Then, you set up your second, SysOp-only, menu command to display the output file that you have TAGMATE creating when it reads "SYSOP.CFG". Simple enough? The parameter for the "LogPhone" option is "V" for their voice phone, "E" for the "Extra Phone Number" field, or "D" for their modem/business/data number. It will say "Phone = " in the log just under their name and city and then display whichever number you want it to. Example: LogPhone V (Displays ALL users' voice phone numbers on a line after their in the log). Once again, make SURE you make it so only trusted staff members of your system can access the menu command to view such a log that contains all of your users personal phone numbers in it! The main purpose of this is for caller-ID comparisons. Thanks to Kevin Martin at WOLF/359 BBS for suggesting this option to me. 3. "TRAK" (DoorStat) ──────────────────── "Trak" is the exact equivalent of DoorStat, except for a few bug fixes here and there. The DoorStat data file is fully-compatible, and all of the options are the exact same except for a few additions. a) Batch file setup =================== The way TAGMate/TRAK calculates which door is ran is told through the MS-DOS command line. In your batch files for all of the doors that you want TAGMate to log, you *MUST* edit a line in there with your favorite text editor that calls TAGMate. I know this may be a pain, but you only have to do it once! You can do it anywhere in the doors' batch file. Here's an example: For the game Solar Realms Elite, assuming you have "Solar Realms Elite" as the door tagname in the setup program (unless you're auto-creating): @ECHO OFF C: CD\BBS\GAMES\SRE SRDOOR SRE %1 C: CD\BBS TAGMATE C:\BBS\TAGMATE.CFG TRAK Solar Realms Elite EXIT Therefore, the parameters in normal execution are: TAGMATE <Configuration file> TRAK <Door tagname> If "<Door tagname>" doesn't exist in the database, it will be automatically created, unless you have this option disabled! b) Menu command setup ===================== What you need to do is create an auto-executing command on your door / external programs menu that displays the output file that you have defined in the configuration file that is located in your AFILES path. Typically, the PKey would be "!", and the PData would be "@DOORSTAT" or what ever the filename is, located in your AFILES path, with no extension. For more information on editing your menus (especially about AUTOEXEC commands) refer to the T.A.G. BBS v2.6d Menu Documentation file (MENU26D.DOC). c) Configurable colors ====================== Depending on your system's color scheme, you and your users may or may not like the looks of the default colors included with TAGMate/TRAK. If not, go ahead and edit them in the configuration file to suit your needs. Most are self-explanatory, and all are explained via commenting in the file. d) Descriptions of the configurable options =========================================== *** NOTE: All options go under the "[Trak]" heading in TAGMATE.CFG! *** Door Auto-Creation ------------------ This version of the door analyzer allows you to auto-create entries into the door database, so you don't have to add them in manually. All you need to do is add the command line into your batch file, then it, by default, automatically creates the entry if it's not found. You can disable this feature with the "NoAutoCreate" option in the configuration file. ASCIIFile --------- "ASCIIFile" allows you to create an ASCII version of the output file that does NOT use T.A.G. BBS ^C# color codes. This comes in handy with other BBS programs and ease of posting in an E-Mail message or transferring in a text file. AutoRestart ----------- TAGMate/TRAK, by default, will NOT automatically reset your door statistics, but you can optionally have it reset them for you on a Daily, Monthly, or Yearly basis. DoorLimit --------- This is simply the highest number of doors that will appear in the output file. Some systems with many doors may want to limit this to about 10 or 15 just so the user doesn't have to sit through a listing of 100 doors every time. :) DOOREDIT.EXE ------------ YOU *MUST* USE DOOREDIT.EXE TO CREATE A NEW DATA BASE FILE! DOOREDIT.EXE is a small executable that is a maintenance keeper for your TAGMate/TRAK door database file. You can use it to manually edit all fields of your door database records, import/export door names from/to an ASCII file, and reset your door statistics manually. The command line for DOOREDIT is: DOOREDIT <Door data base filename> If "<Door data base filename>" doesn't exist, then it will ask you if you want to create it. 4. "SEND" (AutoMail) Mode ───────────────────────── TAGMate/SEND is the exact equivalent of my AutoMail program (originally done by Michael H. Clark) with the exception of JAM(mbp) support, a few bug fixes, and a few more features. a) Input file setup =================== TAGMate/SEND requires an input file that will be posted into the message base. Some default/sample input files for the auto-mailer have been included with the TAGMate archive for you to use as templates. SDR Codes Supported ------------------- Since TAGMate can use just about EVERY TAG SDR code, I'll just tell you the ones that it CAN'T use (in the ASCII input file): For User SDR codes (Control-U): ^U! - Current time left (hh:mm:ss). ^U% - Time left (minutes). ^U* - Time on (hh:mm:ss). For System SDR codes (Control-S): ^SF - Current file board name. ^SL - Current connection control code. ^SK - Current file board <NR>. ^SM - Current message board name. ^SR - Current message board, # active messages. ^SW - Message group mask. ^SY - File group mask. ^S% - Percent active today. Other than those, the SDR codes are fully-compatible and can be used in the exact same way that you use them in any T.A.G. displayable file (.MSG, .CLR, or .RIP file). In addition, you CANNOT use TAB (^T) SDR codes. In fact, they have been replaced by several of my own SDR codes; and they are: When posting a message to a specific user number (#<user number>): ^TG - Displays the user's gender ("M" = Male, "F" = Female). ^TM - Displays the gender name ("Mr" = Male, "Ms" = Female). ^TR - Displays the user's [real] last name. ^TU - Displays the complete user name with right capitalization. b) Batch file setup =================== In order for TAGMate to know how to behave, you must give it certain instruct- ions via the MS-DOS command line (or a line in a batch file). To set SEND up in a batch file (or batch files), please note the following parameters: TAGMATE <Configuration file> SEND <[#]from> <[#]to> <Configuration file> = Complete path and filename to your TAGMATE.CFG that you will be using for this message-posting. See the default configuration file for more details on it. * <[#]from> = This is what will appear in the "From" field in the message header after the message is posted. If you want it to be from an actual user, the format is "#<user number>". Example: "#1" to post a message from user number one in your T.A.G. user database. * <[#]to> = This is what will appear in the "To" field in the message header after the message is posted. If you want it to be to an actual user**, the format is the same as described for the "<[#]from>" parameter. * - In these parameters, you must substitute an underscore character wherever you want to use a space (ASCII #32). See the command line examples below for more details. ** - When you post a message that uses the "#<user number>" feature, you not only can use system SDR codes, you can also use all of the user SDR codes in the body of the message, and they are read in from that particular user's database record in your USER.LST! Example "NEWLOGON.BAT": @ECHO OFF ; Disables command echoing. C: ; Jumps to the C drive. CD\BBS ; Changes to C:\BBS. TAGMATE TAGMATE.CFG SEND #1 #%3 ; Sends E-Mail to the new user. CD\BBS\GFILES ; Changes to C:\BBS\GFILES. MOVE NEWQA.TXT C:\BBS\QUESTION.MSG ; Moves questionnaire to a new file. CD\BBS ; Changes to C:\BBS. TAGMATE TAGMATE.CFG SEND #%3 #1 ; Sends new questionnaire to user 1. TAGMATE TAGMATE.CFG SEND #1 All ; Posts public announcing new user. ECHO ON ; Enables command echoing. More command-line examples: * To send a message from "Joe McElmeel" to "TNT Alpha Sites": TAGMATE TAGMATE.CFG SEND Joe_McElmeel TNT_Alpha_Sites * To send a message from "Jeff Witt" to "Rectal Clinic Employers": TAGMATE TAGMATE.CFG SEND Jeff_Witt Rectal_Clinic_Employers * To send a message from user number 1 to user number 2: TAGMATE TAGMATE.CFG SEND #1 #2 * To send a message from user number 1 to the current user: (this is assuming that AutoMail is run from a TAG batch file) TAGMATE TAGMATE.CFG SEND #1 #%3 c) Descriptions of the configurable options =========================================== *** NOTE: All options go under the "[Send]" heading in TAGMATE.CFG! *** EchoTag ------- Echo tag name of the message area that this configuration file is being used to post with. This option is -required-, but only for EchoMail areas. For example: EchoTag TAG (If I were using TAGMate to post automagically in the TAG support echo...) BoardNumber ----------- If you're posting in a Hudson-style board, you *MUST* define the board number that the message will be posted in. FlagXXXXX --------- These flagged options allow you to enable message status bits such as Crash, Kill/Sent, Sent, Local, FileAttach, RequestReceipt, RequestAudit, ReturnReceipt, FileRequest, Received, and Private. Please see the configuration file for the specifics on how to enable each one. MessageType ----------- Type of message -- Either "E" for EchoMail, or "N" or Normal (Local). InputFile --------- ASCII input file (T.A.G. SDR code-supportive!) that will be used. You can disable the T.A.G. SDR code support via the "NoSDRCodes" option. This is the file that is read in by TAGMate that will be posted into the message base. For more information on the SDR codes, see late in this chapter, and also refer to your T.A.G. BBS v2.6d Main Documentation (MAIN26D.DOC). Format ------ "F" for Fido format (*.MSG, one file per message). "H" for Hudson format (MSG*.BBS, one set of files for the whole base). "J" for JAM format (*.J?R, one set of files per message section). JAM(mbp) - Copyright 1993 Joaquim Homrighausen, Andrew Milner, Mats Birch, Mats Wallin. ALL RIGHTS RESERVED. MsgPath / MsgBaseFile --------------------- Path to the message base. For Fido: Must be complete path to the directory the *.MSG files are stored in, For Hudson: the same as Fido, For JAM: The same, but without the message filename(-extension) (that's what MsgBaseFile is for). HeaderFile / FooterFile ----------------------- ASCII text files (that don't support SDR codes) that can be imported before and after the actual message text in "InputFile". UseOther <v1.15> -------- This option comes in handy if you want to use the user data (that appears in the TAG BBS SDR codes) of the SENDER/AUTHOR of the message rather than the person receiving it (useful if you're posting a message in a public message base and you want it to be FROM a user describing themself via SDR codes). 5. "FILES" (Top 15) Mode ──────────────────────── TAGMate/"FILES" is the exact equivalent of my old Top 15 program, except that the file board restriction options actually work and a couple more bug fixes. a) Batch file setup =================== It is suggested, especially if you have a very large file system, that you only run "FILES" in your midnight maintenance batch file, but if you have a smaller file system, you may want to have an update to the bulletin ran in your POSTDL.BAT file. If you already have a POSTDL.BAT or daily maintenance batch file, edit it and add the following line (otherwise create one): TAGMATE <Configuration file> FILES "<Configuration file>" is the edited, text configuration file that you copied or created from the original "TAGMATE.CFG" that was included with the archive. b) Menu command setup ===================== Get into your system's menu editor by pressing Control-Q or S from the T.A.G. Wait Screen, or by typing "//MENUEDIT" from the main menu if you are running with the default T.A.G. BBS menus. Choose the main menu (or file system menu) by pressing "M" to modify, then the appropriate number to edit. Press I to insert a new command (doesn't matter where it is on the menu). Edit it to what ever descriptions, colors, and keys you want it to be, then change the PKey to "!", and the PData to "@<output file>". "<output file>" is the output filename defined in your configuration file that you used to run TAGMate/FILES with, minus the file extension. c) Configurable colors ====================== Depending on your system's color scheme, you and your users may or may not like the default colors included with TAGMate. If not, go ahead and change them in the text configuration file to what ever looks good on your BBS. d) Descriptions of the configurable options =========================================== *** NOTE: All options go under the "[Files]" heading in TAGMATE.CFG! *** TitleString ----------- Title that will be placed at the top of the bulletin. Used to describe the current bulletin. For instance, if you're using it just for your adult files, have it say "<system name>'s Top 15 Adult Files" or something to that effect. CDROMAreas / NoPassword / UseFlag / MinDSL / MaxDSL --------------------------------------------------- These five options control the way the file boards will be read in. If you want to process CD-ROM sections, un-comment "CDROMAreas". If you don't want to include Password-protected file sections in the bulletin, un-comment the "NoPassword" option. Use "UseFlag <AR flag>" if you want to include file areas that require the "<AR flag>" AR flag for users to access. MinDSL and MaxDSL control the minimum and maximum DSLs required that will be included in the bulletin. TurboMode --------- Turbo Mode enabled will NOT show the current file board that it is processing for increased speed (video access can slow the program down a bit). [New in version 1.12] TurboMode will disable the showing of the bar graph/percentage indicator during file board processing (reduces the number of instructions that it executes significantly, especially speeds thing up on slower machines). AreaNumbers ----------- If you want to include the physical (NOT dynamic!) board numbers in the listing for ease of access, then de-comment this option. Only use this if you have Dynamic File Board numbering DISABLED. 6. Multiple Configuration Files / Setups ──────────────────────────────────────── This section explains exactly how to setup multiple configurations / nodes / setups with all modes of TAGMate. a) "LOG" (NewLog) Mode ====================== For multi-node configuration with "LOG" (NewLog), you first need to make a copy of TAGMATE.CFG for each node, then edit the "MainBBSPath" of each to reflect the correct paths each node. C:\BBS <=- TAG.EXE, TAG.OVR, *.BAT, TAGMATE.EXE, *.CFG. ├───AFILES <=- Shared AFILES (*.MSG, *.CLR, *.RIP). ├───MULTI <=- *.LST, *.DAT. ├───NODE1 <=- STATUS.DAT for node 1. │ └───DFILES <=- SYSOPx.LOG, USAGE.LOG, MODEM.DAT for node 1. └───NODE2 <=- STATUS.DAT for node 2. └───DFILES <=- SYSOPx.LOG, USAGE.LOG, MODEM.DAT for node 2. I renamed TAGMATE.CFG to LOG1.CFG, then copied it to LOG2.CFG and changed the MainBBSDir in LOG2.CFG to "C:\BBS\NODE2\". Below is my LOGON.BAT in C:\BBS\: @ECHO OFF C: CD\BBS TAGMATE LOG%9.CFG LOG /C %3 %8 This goes to the TAGMate directory (C:\BBS\), and then runs it with the correct node's configuration file via the %9 (node number) parameter. Under a multi-node setup, it is optional if you want to have the output files the same. If you do have them the same, then you have a combined system log which is why you probably got this program in the first place. In that case, it is a good idea to use "ExtraField Nodes" rather then "ExtraField Calls" to log which node each called logged into the system with. If you have any questions or are unclear on setting up TAGMate/LOG for more than one node of your system, get in contact with me in any of the ways at the end of this documentation file. b) "SEND" (AutoMail) Mode ========================= If you want to use multiple configuration files with TAGMate/SEND (for posting in different areas, different message base formats, or using different input files) then read on... All that you need to do to make AutoMail support specialized/separate postings, is copy or create the text configuration files (separate filenames, of course), and change what you need to suit your needs as far as the posting. By this I mean: Say you wanted to post on-line game scores every day in your Hudson board #1, in C:\BBS\MSGS\ECHO. Well, you would make a configuration file that would reflect that path (and Hudson board number). And say you called the filename "AMAIL1.CFG". But... You also wanted to post a message to all new users that log onto your system by running TAGMate/SEND in your NEWLOGON.BAT file. All you need to do is make an "AMAIL2.CFG" (and say your path to your Fido E-Mail directory was C:\BBS\MSGS\EMAIL) and have AMAIL2.CFG reflect that it was a Fido message base and was located in C:\BBS\MSGS\EMAIL. Then you simply feed TAGMate the separate command-line parameters when you run them depending on who you want to send the messages to. For instance, your score-posting (in DAILY.BAT, or your maintenance batch file): TAGMATE AMAIL1.CFG SEND #1 All ...And for your new user messages (in NEWLOGON.BAT): TAGMATE AMAIL2.CFG SEND #1 #%3 That should make things clearer as to how to use multiple configuration files for multiple posts, and I sure hope I provided enough examples of command line parameters and configuration files for you to look at. If you don't think so, please get in touch with me (in any or all of the following ways at the end of this documentation file)! c) "FILES" (Top 15) Mode ======================== If you want to have TAGMate/"FILES" create separate bulletins for separate groups of file areas depicable by YOU, then read on... All you need to do is edit separate configuration files for each bulletin that you want to create... Just make sure the output file name is different for each one, and that you restrict the accesses appropriately for each one with- in the configuration files. For instance, I want a COMPLETE listing and an adult-files-only listing... I have ADULT.CFG which has a MinDSL and MaxDSL of 50, and "UseFlag A", but no "UseFlag @". My adult areas require 50 DSL and the "A" AR flag. I would have it create C:\BBS\AFILES\ADULT.MSG, and have a separate menu command in T.A.G. that views "@ADULT" that requires 50 DSL and the A AR flag to access. Then I have COMPLETE.CFG which has a MinDSL of 0 and a MaxDSL of 255, and a "UseFlag _" statement for every single AR flag letter (so I get EVERYTHING, no matter what). It creates C:\BBS\AFILES\TOP15.MSG, and I have the separate command in T.A.G. to view "@TOP15"... My batch file would look like: (POSTDL.BAT / DAILY.BAT / WHATEVER.BAT): @ECHO OFF C: CD\BBS TAGMATE COMPLETE.CFG FILES TAGMATE ADULT.CFG FILES V. Support for TNT Software Products. ═════════════════════════════════════ Definition of "support": Problems, questions, suggestions, comments, queries, complaints, gripes, flames, bug-reports, or anything TAGMate-related. Support for my programs can be found in any (or all) of the following ways: US Mail ======= TNT Software c/o Joe McElmeel 18081 Koester Riverview, MI 48192-7413 InterNet (in order of best chance of reaching me) ======== inferno@gatecom.com (preferred address) Joe.McElmeel%galaxy@ack.mi.org EFNet IRC : "inf" UnderNet IRC : "inferno" BBS === The Galaxy BBS, (313)284-5455, Riverview, Michigan. E-Mail to "SysOp", "1", or "Joe McElmeel" will all get to me. My BBS supports up to 28800 BPS V.34/V.FC/V.32bis/HST. New users have access to the latest versions of all TNT products at no charge. Networks ======== FidoNet = The Galaxy BBS; (1:2410/480); CM,XA,V32B,H16,V34 FidoNet Conferences = FE_HELP, TAG, TAGMULTI, TAG_DOORS, TAGBETA, FE_BETA. VI. Acknowledgements. ═════════════════════ I would like to thank all of the following people for their contributions to TNT Software, especially in this program: Michael Clark (1:2410/238) for originally designing "AutoMail", which later became TAGMate's "SEND" mode. Thanks for the source code and the insight! Elbert Johnson for enhancement/improvement ideas for all "modes" of TAGMate, and for the idea to merge all four smaller programs into one, large program. Jeff Witt for thinking of the name "TNT Software" and for helping out with some program design. Richard Landskroener (1:2410/331) for originally writing NewLog way back in January of 1992. Paul Williams (1:2410/116) for constructive criticism on the NewLog (TAGMate/"LOG") program way-back-when -- forced me to improve it greatly. Victor Capton (1:120/120) for putting up with my pesky phone calls about the JAM message base and for releasing the T.A.G. v2.7 Record Structures. Michael Willard for various bug reports and usage of my program in general! The TNT Software Alpha and Beta teams for testing my buggy programs and for putting up with me. ...And most-importantly -- YOU! For trying my programs and reading this drivel! -End of File-